.. _CScreenInventory Class:

==========================
CScreenInventory Class
==========================

.. toctree::
   :maxdepth: 1

* :ref:`Overview<CScreenInventory_Overview>`
* :ref:`Quick Reference<CScreenInventory_QuickRef>`
* :ref:`Constructors<CScreenInventory_Constructors>`
* :ref:`Methods<CScreenInventory_Methods>`

----

.. _CScreenInventory_Overview:

Overview
---------------

.. note:: The **CScreenInventory** class handles inventory and item management for items that characters carry and items on the ground

The structure used for this class is :ref:`CScreenInventory<CScreenInventory>`

----

.. _CScreenInventory_QuickRef:

Quick Reference
---------------

+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Quick Ref**                                                                                                                                                                                                               |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenInventory\:\:CScreenInventory**\()                                                                                                                                                                            |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenInventory\:\:CancelEngine**\()                                                                                                                                                                        |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenInventory\:\:CheckItemIdentify**\(int nSlot)                                                                                                                                                                  |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual int **CScreenInventory\:\:CheckMouseLButton**\()                                                                                                                                                                    |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual int **CScreenInventory\:\:CheckMouseMove**\()                                                                                                                                                                       |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual int **CScreenInventory\:\:CheckMouseRButton**\()                                                                                                                                                                    |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenInventory\:\:CheckMultiPlayerViewable**\()                                                                                                                                                                    |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| int **CScreenInventory\:\:CheckSlotMergable**\(unsigned long dwSlotId)                                                                                                                                                      |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual int **CScreenInventory\:\:CheckSystemKeyCtrl**\()                                                                                                                                                                   |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenInventory\:\:ClearPortraitHighlighting**\()                                                                                                                                                                   |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenInventory\:\:CopyNote**\(int nButtonId)                                                                                                                                                                       |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenInventory\:\:CopySpell**\(int nButtonId)                                                                                                                                                                      |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenInventory\:\:DrinkPotion**\(int nButtonId)                                                                                                                                                                    |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenInventory\:\:EngineActivated**\()                                                                                                                                                                     |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenInventory\:\:EngineDeactivated**\()                                                                                                                                                                   |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenInventory\:\:EngineDestroyed**\()                                                                                                                                                                     |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenInventory\:\:EngineGameInit**\()                                                                                                                                                                      |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenInventory\:\:EngineGameUninit**\()                                                                                                                                                                    |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenInventory\:\:EngineInitialized**\()                                                                                                                                                                   |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| long **CScreenInventory\:\:FetchGroundPile**\(short nPortraitId, int bEvenIfDead)                                                                                                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| unsigned long **CScreenInventory\:\:FindFreePersonalSlot**\(unsigned long dwFirstId, unsigned long dwLastId)                                                                                                                |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenInventory\:\:FlushGroundPiles**\()                                                                                                                                                                            |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| CGameButtonList\* **CScreenInventory\:\:GetAbilitiesList**\(int nButtonId)                                                                                                                                                  |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`CString<CString>` **CScreenInventory\:\:GetButtonString**\(int nButtonId)                                                                                                                                             |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| int **CScreenInventory\:\:GetCurrentGroundPage**\()                                                                                                                                                                         |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| int **CScreenInventory\:\:GetMaxGroundPage**\()                                                                                                                                                                             |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual short **CScreenInventory\:\:GetNumVirtualKeys**\()                                                                                                                                                                  |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| int **CScreenInventory\:\:GetPersonalSlotHighlight**\(int nButtonId)                                                                                                                                                        |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| int **CScreenInventory\:\:GetScrollIdentifyEnabled**\(int nButtonId)                                                                                                                                                        |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| int **CScreenInventory\:\:GetSlotHighlight**\(int nButtonId)                                                                                                                                                                |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| unsigned long **CScreenInventory\:\:GetSlotIdForTempItem**\()                                                                                                                                                               |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| int **CScreenInventory\:\:GetSpellIdentifyEnabled**\(int nButtonId)                                                                                                                                                         |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| int **CScreenInventory\:\:GetUseButtonMode**\(int nButtonId)                                                                                                                                                                |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`CString<CString>` **CScreenInventory\:\:GetUseButtonText**\(int nButtonId, int nMode)                                                                                                                                 |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual :ref:`CKeyInfo<CKeyInfo>`\* **CScreenInventory\:\:GetVirtualKeys**\()                                                                                                                                               |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual int\* **CScreenInventory\:\:GetVirtualKeysFlags**\()                                                                                                                                                                |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| int **CScreenInventory\:\:GetWeaponSlotHighlight**\(int nButtonId)                                                                                                                                                          |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenInventory\:\:IdentifyWithScroll**\(int nButtonId)                                                                                                                                                             |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenInventory\:\:IdentifyWithSpell**\(int nButtonId)                                                                                                                                                              |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| int **CScreenInventory\:\:IsAbilitiesButtonActive**\(int nButtonId)                                                                                                                                                         |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| int **CScreenInventory\:\:IsCharacterInRange**\(int nPortraitNum)                                                                                                                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| int **CScreenInventory\:\:IsSlotValid**\(unsigned long dwSlotId)                                                                                                                                                            |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| int **CScreenInventory\:\:IsSpriteOrderable**\()                                                                                                                                                                            |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| int **CScreenInventory\:\:IsUseButtonActive**\(int nButtonId, int nButtonMode)                                                                                                                                              |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| int **CScreenInventory\:\:MapButtonIdToInventoryId**\(int nButtonId)                                                                                                                                                        |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenInventory\:\:MapButtonIdToItemInfo**\(int nButtonId, :ref:`CItem<CItem>`\*\& pItem, unsigned long\& strDesc, :ref:`CResRef<CResRef>`\& cResIcon, :ref:`CResRef<CResRef>`\& cResItem, unsigned short\& wCount) |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenInventory\:\:OnGroundPage**\(int nPages)                                                                                                                                                                      |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenInventory\:\:OnKeyDown**\(int nKeysFlags)                                                                                                                                                             |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenInventory\:\:OnLButtonDblClk**\(:ref:`CPoint<CPoint>` cPoint)                                                                                                                                         |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenInventory\:\:OnLButtonDown**\(:ref:`CPoint<CPoint>` cPoint)                                                                                                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenInventory\:\:OnLButtonUp**\(:ref:`CPoint<CPoint>` cPoint)                                                                                                                                             |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenInventory\:\:OnPortraitLClick**\(unsigned long id)                                                                                                                                                    |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenInventory\:\:OnMouseMove**\(:ref:`CPoint<CPoint>` cPoint)                                                                                                                                             |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenInventory\:\:OnRButtonDown**\(:ref:`CPoint<CPoint>` cPoint)                                                                                                                                           |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenInventory\:\:OnRButtonUp**\(:ref:`CPoint<CPoint>` cPoint)                                                                                                                                             |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenInventory\:\:OnRestButtonClick**\()                                                                                                                                                                   |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenInventory\:\:OnUseButtonClick**\(int nButtonId, int nButtonMode)                                                                                                                                              |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenInventory\:\:PlaySwapSound**\(:ref:`CItem<CItem>`\* pOldItem, :ref:`CItem<CItem>`\* pNewItem)                                                                                                                 |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenInventory\:\:RenderEncumbrance**\(:ref:`CPoint<CPoint>` pos, :ref:`CRect<CRect>` rClip)                                                                                                                       |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenInventory\:\:ResetGroundPile**\()                                                                                                                                                                             |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenInventory\:\:SelectItemAbility**\(int nAbility, int nItem, int nButtonId)                                                                                                                                     |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenInventory\:\:SetErrorString**\(const unsigned long strError, const unsigned long crColor)                                                                                                                     |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenInventory\:\:SetSystemKeyCtrl**\(unsigned char bValue)                                                                                                                                                |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| int **CScreenInventory\:\:SwapWithPortrait**\(int nButtonId, int bShowError)                                                                                                                                                |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| int **CScreenInventory\:\:SwapWithSlot**\(int nButtonId, int bShowError, unsigned short wCount, int bAutoStacking)                                                                                                          |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenInventory\:\:TimerAsynchronousUpdate**\()                                                                                                                                                             |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenInventory\:\:TimerSynchronousUpdate**\()                                                                                                                                                              |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenInventory\:\:UnPauseGame**\()                                                                                                                                                                                 |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenInventory\:\:UpdateContainerStatus**\(long nContainerId, short nSlotNum)                                                                                                                              |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenInventory\:\:UpdateLua**\()                                                                                                                                                                                   |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenInventory\:\:UpdatePersonalItemStatus**\(long nSpriteId)                                                                                                                                              |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+


----

.. _CScreenInventory_Constructors:

Constructors
---------------

+--------------------------------------------------------------------------------+------------------------------------------------------+
| **Name**                                                                       | **Description**                                      |
+--------------------------------------------------------------------------------+------------------------------------------------------+
| :ref:`CScreenInventory\:\:CScreenInventory<CScreenInventoryCScreenInventory>`  | Constructs a ``CScreenInventory`` object             |
+--------------------------------------------------------------------------------+------------------------------------------------------+

.. _CScreenInventoryCScreenInventory:

CScreenInventory\:\:CScreenInventory
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Constructs a ``CScreenInventory`` object

::

   void CScreenInventory::CScreenInventory();

**Remarks**

Constructs a ``CScreenInventory`` object


----

.. _CScreenInventory_Methods:

Methods
---------------

+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| **Name**                                                                                            | **Description**                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:CancelEngine<CScreenInventoryCancelEngine>`                               |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:CheckItemIdentify<CScreenInventoryCheckItemIdentify>`                     |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:CheckMouseLButton<CScreenInventoryCheckMouseLButton>`                     |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:CheckMouseMove<CScreenInventoryCheckMouseMove>`                           |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:CheckMouseRButton<CScreenInventoryCheckMouseRButton>`                     |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:CheckMultiPlayerViewable<CScreenInventoryCheckMultiPlayerViewable>`       |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:CheckSlotMergable<CScreenInventoryCheckSlotMergable>`                     |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:CheckSystemKeyCtrl<CScreenInventoryCheckSystemKeyCtrl>`                   |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:ClearPortraitHighlighting<CScreenInventoryClearPortraitHighlighting>`     |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:CopyNote<CScreenInventoryCopyNote>`                                       |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:CopySpell<CScreenInventoryCopySpell>`                                     |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:DrinkPotion<CScreenInventoryDrinkPotion>`                                 |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:EngineActivated<CScreenInventoryEngineActivated>`                         |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:EngineDeactivated<CScreenInventoryEngineDeactivated>`                     |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:EngineDestroyed<CScreenInventoryEngineDestroyed>`                         |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:EngineGameInit<CScreenInventoryEngineGameInit>`                           |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:EngineGameUninit<CScreenInventoryEngineGameUninit>`                       |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:EngineInitialized<CScreenInventoryEngineInitialized>`                     |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:FetchGroundPile<CScreenInventoryFetchGroundPile>`                         |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:FindFreePersonalSlot<CScreenInventoryFindFreePersonalSlot>`               |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:FlushGroundPiles<CScreenInventoryFlushGroundPiles>`                       |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:GetAbilitiesList<CScreenInventoryGetAbilitiesList>`                       |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:GetButtonString<CScreenInventoryGetButtonString>`                         |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:GetCurrentGroundPage<CScreenInventoryGetCurrentGroundPage>`               |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:GetMaxGroundPage<CScreenInventoryGetMaxGroundPage>`                       |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:GetNumVirtualKeys<CScreenInventoryGetNumVirtualKeys>`                     |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:GetPersonalSlotHighlight<CScreenInventoryGetPersonalSlotHighlight>`       |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:GetScrollIdentifyEnabled<CScreenInventoryGetScrollIdentifyEnabled>`       |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:GetSlotHighlight<CScreenInventoryGetSlotHighlight>`                       |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:GetSlotIdForTempItem<CScreenInventoryGetSlotIdForTempItem>`               |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:GetSpellIdentifyEnabled<CScreenInventoryGetSpellIdentifyEnabled>`         |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:GetUseButtonMode<CScreenInventoryGetUseButtonMode>`                       |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:GetUseButtonText<CScreenInventoryGetUseButtonText>`                       |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:GetVirtualKeys<CScreenInventoryGetVirtualKeys>`                           |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:GetVirtualKeysFlags<CScreenInventoryGetVirtualKeysFlags>`                 |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:GetWeaponSlotHighlight<CScreenInventoryGetWeaponSlotHighlight>`           |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:IdentifyWithScroll<CScreenInventoryIdentifyWithScroll>`                   |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:IdentifyWithSpell<CScreenInventoryIdentifyWithSpell>`                     |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:IsAbilitiesButtonActive<CScreenInventoryIsAbilitiesButtonActive>`         |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:IsCharacterInRange<CScreenInventoryIsCharacterInRange>`                   |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:IsSlotValid<CScreenInventoryIsSlotValid>`                                 |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:IsSpriteOrderable<CScreenInventoryIsSpriteOrderable>`                     |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:IsUseButtonActive<CScreenInventoryIsUseButtonActive>`                     |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:MapButtonIdToInventoryId<CScreenInventoryMapButtonIdToInventoryId>`       |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:MapButtonIdToItemInfo<CScreenInventoryMapButtonIdToItemInfo>`             |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:OnGroundPage<CScreenInventoryOnGroundPage>`                               |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:OnKeyDown<CScreenInventoryOnKeyDown>`                                     |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:OnLButtonDblClk<CScreenInventoryOnLButtonDblClk>`                         |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:OnLButtonDown<CScreenInventoryOnLButtonDown>`                             |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:OnLButtonUp<CScreenInventoryOnLButtonUp>`                                 |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:OnPortraitLClick<CScreenInventoryOnPortraitLClick>`                       |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:OnMouseMove<CScreenInventoryOnMouseMove>`                                 |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:OnRButtonDown<CScreenInventoryOnRButtonDown>`                             |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:OnRButtonUp<CScreenInventoryOnRButtonUp>`                                 |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:OnRestButtonClick<CScreenInventoryOnRestButtonClick>`                     |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:OnUseButtonClick<CScreenInventoryOnUseButtonClick>`                       |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:PlaySwapSound<CScreenInventoryPlaySwapSound>`                             |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:RenderEncumbrance<CScreenInventoryRenderEncumbrance>`                     |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:ResetGroundPile<CScreenInventoryResetGroundPile>`                         |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:SelectItemAbility<CScreenInventorySelectItemAbility>`                     |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:SetErrorString<CScreenInventorySetErrorString>`                           |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:SetSystemKeyCtrl<CScreenInventorySetSystemKeyCtrl>`                       |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:SwapWithPortrait<CScreenInventorySwapWithPortrait>`                       |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:SwapWithSlot<CScreenInventorySwapWithSlot>`                               |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:TimerAsynchronousUpdate<CScreenInventoryTimerAsynchronousUpdate>`         |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:TimerSynchronousUpdate<CScreenInventoryTimerSynchronousUpdate>`           |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:UnPauseGame<CScreenInventoryUnPauseGame>`                                 |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:UpdateContainerStatus<CScreenInventoryUpdateContainerStatus>`             |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:UpdateLua<CScreenInventoryUpdateLua>`                                     |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenInventory\:\:UpdatePersonalItemStatus<CScreenInventoryUpdatePersonalItemStatus>`       |                                                                                         |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+


----

.. _CScreenInventoryCancelEngine:

CScreenInventory\:\:CancelEngine
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryCheckItemIdentify:

CScreenInventory\:\:CheckItemIdentify
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryCheckMouseLButton:

CScreenInventory\:\:CheckMouseLButton
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryCheckMouseMove:

CScreenInventory\:\:CheckMouseMove
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryCheckMouseRButton:

CScreenInventory\:\:CheckMouseRButton
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryCheckMultiPlayerViewable:

CScreenInventory\:\:CheckMultiPlayerViewable
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryCheckSlotMergable:

CScreenInventory\:\:CheckSlotMergable
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryCheckSystemKeyCtrl:

CScreenInventory\:\:CheckSystemKeyCtrl
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryClearPortraitHighlighting:

CScreenInventory\:\:ClearPortraitHighlighting
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryCopyNote:

CScreenInventory\:\:CopyNote
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryCopySpell:

CScreenInventory\:\:CopySpell
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryDrinkPotion:

CScreenInventory\:\:DrinkPotion
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryEngineActivated:

CScreenInventory\:\:EngineActivated
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryEngineDeactivated:

CScreenInventory\:\:EngineDeactivated
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryEngineDestroyed:

CScreenInventory\:\:EngineDestroyed
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryEngineGameInit:

CScreenInventory\:\:EngineGameInit
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryEngineGameUninit:

CScreenInventory\:\:EngineGameUninit
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryEngineInitialized:

CScreenInventory\:\:EngineInitialized
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryFetchGroundPile:

CScreenInventory\:\:FetchGroundPile
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryFindFreePersonalSlot:

CScreenInventory\:\:FindFreePersonalSlot
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryFlushGroundPiles:

CScreenInventory\:\:FlushGroundPiles
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryGetAbilitiesList:

CScreenInventory\:\:GetAbilitiesList
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryGetButtonString:

CScreenInventory\:\:GetButtonString
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryGetCurrentGroundPage:

CScreenInventory\:\:GetCurrentGroundPage
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryGetMaxGroundPage:

CScreenInventory\:\:GetMaxGroundPage
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryGetNumVirtualKeys:

CScreenInventory\:\:GetNumVirtualKeys
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryGetPersonalSlotHighlight:

CScreenInventory\:\:GetPersonalSlotHighlight
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryGetScrollIdentifyEnabled:

CScreenInventory\:\:GetScrollIdentifyEnabled
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryGetSlotHighlight:

CScreenInventory\:\:GetSlotHighlight
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryGetSlotIdForTempItem:

CScreenInventory\:\:GetSlotIdForTempItem
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryGetSpellIdentifyEnabled:

CScreenInventory\:\:GetSpellIdentifyEnabled
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryGetUseButtonMode:

CScreenInventory\:\:GetUseButtonMode
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryGetUseButtonText:

CScreenInventory\:\:GetUseButtonText
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryGetVirtualKeys:

CScreenInventory\:\:GetVirtualKeys
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryGetVirtualKeysFlags:

CScreenInventory\:\:GetVirtualKeysFlags
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryGetWeaponSlotHighlight:

CScreenInventory\:\:GetWeaponSlotHighlight
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryIdentifyWithScroll:

CScreenInventory\:\:IdentifyWithScroll
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryIdentifyWithSpell:

CScreenInventory\:\:IdentifyWithSpell
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryIsAbilitiesButtonActive:

CScreenInventory\:\:IsAbilitiesButtonActive
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryIsCharacterInRange:

CScreenInventory\:\:IsCharacterInRange
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryIsSlotValid:

CScreenInventory\:\:IsSlotValid
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryIsSpriteOrderable:

CScreenInventory\:\:IsSpriteOrderable
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryIsUseButtonActive:

CScreenInventory\:\:IsUseButtonActive
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryMapButtonIdToInventoryId:

CScreenInventory\:\:MapButtonIdToInventoryId
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryMapButtonIdToItemInfo:

CScreenInventory\:\:MapButtonIdToItemInfo
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryOnGroundPage:

CScreenInventory\:\:OnGroundPage
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryOnKeyDown:

CScreenInventory\:\:OnKeyDown
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryOnLButtonDblClk:

CScreenInventory\:\:OnLButtonDblClk
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryOnLButtonDown:

CScreenInventory\:\:OnLButtonDown
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryOnLButtonUp:

CScreenInventory\:\:OnLButtonUp
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryOnPortraitLClick:

CScreenInventory\:\:OnPortraitLClick
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryOnMouseMove:

CScreenInventory\:\:OnMouseMove
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryOnRButtonDown:

CScreenInventory\:\:OnRButtonDown
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryOnRButtonUp:

CScreenInventory\:\:OnRButtonUp
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryOnRestButtonClick:

CScreenInventory\:\:OnRestButtonClick
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryOnUseButtonClick:

CScreenInventory\:\:OnUseButtonClick
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryPlaySwapSound:

CScreenInventory\:\:PlaySwapSound
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryRenderEncumbrance:

CScreenInventory\:\:RenderEncumbrance
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryResetGroundPile:

CScreenInventory\:\:ResetGroundPile
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventorySelectItemAbility:

CScreenInventory\:\:SelectItemAbility
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventorySetErrorString:

CScreenInventory\:\:SetErrorString
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventorySetSystemKeyCtrl:

CScreenInventory\:\:SetSystemKeyCtrl
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventorySwapWithPortrait:

CScreenInventory\:\:SwapWithPortrait
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventorySwapWithSlot:

CScreenInventory\:\:SwapWithSlot
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryTimerAsynchronousUpdate:

CScreenInventory\:\:TimerAsynchronousUpdate
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryTimerSynchronousUpdate:

CScreenInventory\:\:TimerSynchronousUpdate
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryUnPauseGame:

CScreenInventory\:\:UnPauseGame
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryUpdateContainerStatus:

CScreenInventory\:\:UpdateContainerStatus
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryUpdateLua:

CScreenInventory\:\:UpdateLua
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenInventoryUpdatePersonalItemStatus:

CScreenInventory\:\:UpdatePersonalItemStatus
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**